package com.lst.tools.redis.service;

import redis.clients.jedis.BinaryClient;

import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * 类描述：Redis业务层
 *
 * @author: Frank
 * @date: 2019/09/24 13:51
 * @version: V1.0
 */
public interface IRedisService {

    /**
     * 设置一个redis字符串值
     *
     * @param key   键
     * @param value 值
     * @return 设置结果
     */
    String set(String key, String value);

    /**
     * 设置一个redis字符串值并设置其生成时间
     *
     * @param key           键
     * @param expireSeconds 生存时间
     * @param value         值
     * @return 设置结果
     */
    String setEx(String key, int expireSeconds, String value);

    /**
     * 设置key value,如果key已经存在则返回0
     *
     * @param key
     * @param value
     * @return
     */
    long setNx(String key, String value);

    /**
     * 通过key 和offset 从指定的位置开始将原先value替换
     *
     * @param key
     * @param offset
     * @param value
     * @return
     */
    long setRange(String key, int offset, String value);

    /**
     * 获取key对应的值
     *
     * @param key
     * @return
     */
    String get(String key);


    /**
     * 删除key对应的值
     *
     * @param keys
     * @return 设置结果
     */
    long del(String... keys);

    /**
     * 判断key是否存在
     *
     * @param key
     * @return
     */
    boolean exists(String key);

    /**
     * 通过批量的key获取批量的value
     *
     * @param keys
     * @return
     */
    List<String> mGet(String... keys);

    /**
     * 批量的设置key:value,也可以一个
     *
     * @param keysValues
     * @return
     */
    String mSet(String... keysValues);

    /**
     * 批量的设置key:value,可以一个,如果key已经存在则会失败,操作会回滚
     *
     * @param keysValues
     * @return
     */
    long mSetNx(String... keysValues);

    /**
     * 设置key的值,并返回一个旧值
     *
     * @param key
     * @param value
     * @return
     */
    String getSet(String key, String value);

    /**
     * 通过下标 和key 获取指定下标位置的 value
     *
     * @param key
     * @param startOffset
     * @param endOffset
     * @return
     */
    String getRange(String key, int startOffset, int endOffset);

    /**
     * 通过key 对value进行加值+1操作,当value不是int类型时会返回错误,当key不存在是则value为1
     *
     * @param key
     * @return
     */
    long incr(String key);

    /**
     * 通过key给指定的value加值,如果key不存在,则这是value为该值
     *
     * @param key
     * @param integer
     * @return
     */
    long incrBy(String key, long integer);

    /**
     * 对key的值做减减操作,如果key不存在,则设置key为-1
     *
     * @param key
     * @return
     */
    long decr(String key);

    /**
     * 减去指定的值
     *
     * @param key
     * @param integer
     * @return
     */
    long decrBy(String key, long integer);

    /**
     * 通过key获取value值的长度
     *
     * @param key
     * @return
     */
    long strLen(String key);

    /**
     * 通过key给field设置指定的值,如果key不存在则先创建,如果field已经存在,返回0
     *
     * @param key
     * @param field
     * @param value
     * @return
     */
    long hSetNx(String key, String field, String value);

    /**
     * 通过key给field设置指定的值,如果key不存在,则先创建
     *
     * @param key
     * @param field
     * @param value
     * @return
     */
    long hSet(String key, String field, String value);

    /**
     * 通过key同时设置 hash的多个field
     *
     * @param key
     * @param hash
     * @return
     */
    String hMSet(String key, Map<String, String> hash);

    /**
     * 通过key 和 field 获取指定的 value
     *
     * @param key
     * @param field
     * @return
     */
    String hGet(String key, String field);

    /**
     * 设置key的超时时间为seconds
     *
     * @param key
     * @param seconds
     * @return
     */
    long expire(String key, int seconds);

    /**
     * 通过key 和 fields 获取指定的value 如果没有对应的value则返回null
     *
     * @param key
     * @param fields 可以是 一个String 也可以是 String数组
     * @return
     */
    List<String> hMGet(String key, String... fields);

    /**
     * 通过key给指定的field的value加上给定的值
     *
     * @param key
     * @param field
     * @param value
     * @return
     */
    long hIncrBy(String key, String field, long value);

    /**
     * 通过key和field判断是否有指定的value存在
     *
     * @param key
     * @param field
     * @return
     */
    boolean hExists(String key, String field);

    /**
     * 通过key返回field的数量
     *
     * @param key
     * @return
     */
    long hLen(String key);

    /**
     * 通过key 删除指定的 field
     *
     * @param key
     * @param fields 可以是 一个 field 也可以是 一个数组
     * @return
     */
    long hDel(String key, String... fields);

    /**
     * 通过key返回所有的field
     *
     * @param key
     * @return
     */
    Set<String> hKeys(String key);

    /**
     * 通过key返回所有和key有关的value
     *
     * @param key
     * @return
     */
    List<String> hVals(String key);

    /**
     * 通过key获取所有的field和value
     *
     * @param key
     * @return
     */
    Map<String, String> hGetAll(String key);

    /**
     * 通过key向list头部添加字符串
     *
     * @param key
     * @param strs 可以是一个string 也可以是string数组
     * @return 返回list的value个数
     */
    long lPush(String key, String... strs);

    /**
     * 通过key向list尾部添加字符串
     *
     * @param key
     * @param strs 可以是一个string 也可以是string数组
     * @return 返回list的value个数
     */
    long rPush(String key, String... strs);

    /**
     * 通过key在list指定的位置之前或者之后 添加字符串元素
     *
     * @param key
     * @param where LIST_POSITION枚举类型
     * @param pivot list里面的value
     * @param value 添加的value
     * @return
     */
    long lInsert(String key, BinaryClient.LIST_POSITION where,
                 String pivot, String value);

    /**
     * 通过key设置list指定下标位置的value
     * 如果下标超过list里面value的个数则报错
     *
     * @param key
     * @param index 从0开始
     * @param value
     * @return 成功返回OK
     */
    String lSet(String key, long index, String value);

    /**
     * 通过key从对应的list中删除指定的count个 和 value相同的元素
     *
     * @param key
     * @param count 当count为0时删除全部
     * @param value
     * @return 返回被删除的个数
     */
    long lRem(String key, long count, String value);

    /**
     * 通过key保留list中从strat下标开始到end下标结束的value值
     *
     * @param key
     * @param start
     * @param end
     * @return 成功返回OK
     */
    String lTrim(String key, long start, long end);

    /**
     * 通过key从list的头部删除一个value,并返回该value
     *
     * @param key
     * @return
     */
    String lPop(String key);

    /**
     * 通过key从list尾部删除一个value,并返回该元素
     *
     * @param key
     * @return
     */
    String rPop(String key);

    /**
     * 通过key从一个list的尾部删除一个value并添加到另一个list的头部,并返回该value
     * 如果第一个list为空或者不存在则返回null
     *
     * @param srckey
     * @param dstkey
     * @return
     */
    String rPopLPush(String srckey, String dstkey);

    /**
     * 通过key获取list中指定下标位置的value
     *
     * @param key
     * @param index
     * @return 如果没有返回null
     */
    String lIndex(String key, long index);

    /**
     * 通过key返回list的长度
     *
     * @param key
     * @return
     */
    long lLen(String key);

    /**
     * 通过key获取list指定下标位置的value
     * 如果start 为 0 end 为 -1 则返回全部的list中的value
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    List<String> lRange(String key, long start, long end);

    /**
     * 通过key向指定的set中添加value
     *
     * @param key
     * @param members 可以是一个String 也可以是一个String数组
     * @return 添加成功的个数
     */
    long sAdd(String key, String... members);

    /**
     * 通过key删除set中对应的value值
     *
     * @param key
     * @param members 可以是一个String 也可以是一个String数组
     * @return 删除的个数
     */
    long sRem(String key, String... members);

    /**
     * 通过key随机删除一个set中的value并返回该值
     *
     * @param key
     * @return
     */
    String sPop(String key);

    /**
     * 通过key获取set中的差集
     * 以第一个set为标准
     *
     * @param keys 可以 是一个string 则返回set中所有的value 也可以是string数组
     * @return
     */
    Set<String> sDiff(String... keys);

    /**
     * 通过key获取set中的差集并存入到另一个key中
     * 以第一个set为标准
     *
     * @param dstkey 差集存入的key
     * @param keys   可以 是一个string 则返回set中所有的value 也可以是string数组
     * @return
     */
    long sDiffStore(String dstkey, String... keys);

    /**
     * 通过key获取指定set中的交集
     *
     * @param keys 可以 是一个string 也可以是一个string数组
     * @return
     */
    Set<String> sInter(String... keys);

    /**
     * 通过key获取指定set中的交集 并将结果存入新的set中
     *
     * @param dstkey
     * @param keys   可以 是一个string 也可以是一个string数组
     * @return
     */
    long sInterStore(String dstkey, String... keys);

    /**
     * 通过key返回所有set的并集
     *
     * @param keys 可以 是一个string 也可以是一个string数组
     * @return
     */
    Set<String> sUnion(String... keys);

    /**
     * 通过key返回所有set的并集,并存入到新的set中
     *
     * @param dstkey
     * @param keys   可以 是一个string 也可以是一个string数组
     * @return
     */
    long sUnionStore(String dstkey, String... keys);

    /**
     * 通过key将set中的value移除并添加到第二个set中
     *
     * @param srckey 需要移除的
     * @param dstkey 添加的
     * @param member set中的value
     * @return
     */
    long sMove(String srckey, String dstkey, String member);

    /**
     * 通过key获取set中value的个数
     *
     * @param key
     * @return
     */
    long sCard(String key);

    /**
     * 通过key判断value是否是set中的元素
     *
     * @param key
     * @param member
     * @return
     */
    boolean sIsMember(String key, String member);

    /**
     * 通过key获取set中随机的value,不删除元素
     *
     * @param key
     * @return
     */
    String sRandMember(String key);

    /**
     * 通过key获取set中所有的value
     *
     * @param key
     * @return
     */
    Set<String> sMembers(String key);


    /**
     * 通过key向zset中添加value,score,其中score就是用来排序的
     * 如果该value已经存在则根据score更新元素
     *
     * @param key
     * @param score
     * @param member
     * @return
     */
    long zAdd(String key, double score, String member);

    /**
     * 通过key删除在zset中指定的value
     *
     * @param key
     * @param members 可以 是一个string 也可以是一个string数组
     * @return
     */
    long zRem(String key, String... members);

    /**
     * 通过key增加该zset中value的score的值
     *
     * @param key
     * @param score
     * @param member
     * @return
     */
    Double zIncrBy(String key, double score, String member);

    /**
     * 通过key返回zset中value的排名
     * 下标从小到大排序
     *
     * @param key
     * @param member
     * @return
     */
    long zRank(String key, String member);

    /**
     * 通过key返回zset中value的排名
     * 下标从大到小排序
     *
     * @param key
     * @param member
     * @return
     */
    long zRevRank(String key, String member);

    /**
     * 通过key将获取score从start到end中zset的value
     * socre从大到小排序
     * 当start为0 end为-1时返回全部
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    Set<String> zRevRange(String key, long start, long end);

    /**
     * 通过key返回指定score内zset中的value
     *
     * @param key
     * @param max
     * @param min
     * @return
     */
    Set<String> zRangeByScore(String key, String max, String min);

    /**
     * 通过key返回指定score内zset中的value
     *
     * @param key
     * @param max
     * @param min
     * @return
     */
    Set<String> zRangeByScore(String key, double max, double min);

    /**
     * 返回指定区间内zset中value的数量
     *
     * @param key
     * @param min
     * @param max
     * @return
     */
    long zCount(String key, String min, String max);

    /**
     * 通过key返回zset中的value个数
     *
     * @param key
     * @return
     */
    long zCard(String key);

    /**
     * 通过key获取zset中value的score值
     *
     * @param key
     * @param member
     * @return
     */
    Double zScore(String key, String member);

    /**
     * 通过key删除给定区间内的元素
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    long zRemRangeByRank(String key, long start, long end);

    /**
     * 通过key删除指定score内的元素
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    long zRemRangeByScore(String key, double start, double end);

    /**
     * 返回满足pattern表达式的所有key
     * keys(*)
     * 返回所有的key
     *
     * @param pattern
     * @return
     */
    Set<String> keys(String pattern);

    /**
     * 通过key判断值得类型
     *
     * @param key
     * @return
     */
    String type(String key);
}
